home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / hsl-tgb5.zip / HSLK-TGI.DOC < prev    next >
Text File  |  1992-02-28  |  18KB  |  577 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.            |  HSLK-TGI v1.00 Beta Documentation
  14.            |
  15.            |  HS\Link Bidirectional Protocol Interface for Telegard.
  16.            |
  17.            |  Copyright 1991,1992 by Tim Strike and
  18.            |  Forbidden Knights [BBS] Software Systems and Programming.
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.                                  _________________
  68.  
  69.                                  TABLE OF CONTENTS
  70.                                  _________________
  71.  
  72.            I    Introduction ........................................  1
  73.            II   Required to Run HSLK-TGI ............................  1
  74.            III  Command Line Parameters .............................  2
  75.            IV   Other Notes
  76.                  - Status Line ......................................  3
  77.                  - After Upload Processing ..........................  3
  78.            V    Example Installation ................................  4
  79.            VI   Verion Listings .....................................  5
  80.            VII  Legalities
  81.                  - Warranty .........................................  6
  82.                  - Copyright ........................................  6
  83.                  - Credits ..........................................  6
  84.            VIII Registration ......................................  7
  85.            IX   Contacting The Author ...............................  7
  86.  
  87.  
  88.             The contents of this document are Copyright 1991, 1992 by Tim
  89.             Strike and Forbididden Knights [BBS] Software Systems and
  90.             Programming.  They are not to be modified in any way, shape or
  91.             form.
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.                                       ____________
  132.  
  133.                                       INTRODUCTION
  134.                                       ____________
  135.  
  136.                For use with Telegard 2.7.   If used with any other  versions
  137.           of TG, HSLK-TGI will cause unpredictable and unrepairable results.
  138.  
  139.                Upon the release of HS\Link, a bidirectional protocol, it was
  140.           again discovered how  much Telegard  lacked in  the file  protocol
  141.           handling.    While  HS\Link  could   be  setup  as  a   single-way
  142.           protocol in  Telegard, it  couldn't be  installed proplerly  as  a
  143.           bidirectional protocol, without a lot of hassle, and inconvenience
  144.           for the Sysop.   HSLK-TGI was designed  to interface HS\Link  with
  145.           Telegard so this  would no longer  be a problem.   HSLK-TGI  takes
  146.           care  of  the  uploading  portion,  letting  Telegard  handle  the
  147.           downloading side.
  148.  
  149.                HSLK-TGI  when  fully  setup  replicates  the  Telegard  file
  150.           section, or  how  Telegard  would normally  act,  except  that  it
  151.           handles both  uploads and  downloads at  the same  time.   However
  152.           HSLK-TGI doesn't replicate Telegards file section in all  regards,
  153.           o not all setups will work correctly with this version (though  if
  154.           you explain  to  me  what  the  problem  is  I'll  get  around  to
  155.           programming it.).
  156.  
  157.                THIS COPY OF HSLK-TGI IS STILL  IN IT'S BETA STAGES.  IT  HAS
  158.           BEEN TESTED, BUT IS NOT GUARENTEED TO RUN OR OPERATE CORRECTLY  ON
  159.           YOUR SYSTEM.  ALL ATTEMPTS WILL BE MADE TO MAKE SURE THAT IT  DOES
  160.           RUN ON YOUR SYSTEM, BUT TIM STRIKE AND FORBIDDEN KNIGHTS  SOFTWARE
  161.           ARE NOT RESPONSIBLE FOR  ANY PROBLEMS THAT OCCUR  FROM THE USE  OR
  162.           MISUSE OF THIS PROGRAM.
  163.  
  164.                                 ________________________
  165.  
  166.                                 REQUIRED TO RUN HSLK-TGI
  167.                                 ________________________
  168.  
  169.                HSLK-TGI requires  access  to  STATUS.DAT,  LASTON.DAT,  your
  170.           USER.LST and  the file  directories.  From these  files,  HSLK-TGI
  171.           determines who was last on (Since there are no drop files created)
  172.           and loads in their user data.   It also gathers information  about
  173.           your file bases and manages the total uploads/user uploads for the
  174.           transfer.
  175.  
  176.                HSLK-TGI also requires that HS\Link be setup and working upon
  177.           this installation.  There will  be a few minor modifications,  but
  178.           for the most part setup HS\Link following the guidelines  outlined
  179.           in the HSLINK.DOC file provided with your copy of HS\Link.
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.                                                  - Page 1 -
  190.  
  191.                              Telegard Hs\Link Interface v1.00 Beta Documentation
  192.                           Copyright 1991,1992 by Tim Strike.  All rights reserved.
  193.  
  194.  
  195.                                  _______________________
  196.  
  197.                                  COMMAND LINE PARAMETERS
  198.                                  _______________________
  199.  
  200.  
  201.                HSLK-TGI needs  a rather  extensive command  line.   Wherever
  202.           possible, all "defaults" for HS\Link  should be setup in a  config
  203.           file so that the command  line doesn't excess the maximum  allowed
  204.           by Telegard.
  205.  
  206.                 HSLK-TGI must be run in this fassion, else it will not  work
  207.           properly:
  208.  
  209.           HSLK-TGI BBS_PATH # PORT BAUD <HS\Link Commands>
  210.  
  211.           BBS_PATH is  the  direct  path  to your  STATUS.DAT  file.  The  #
  212.           parameter corresponds to the directory  where the uploads will  go
  213.           (and it might  be wise to  make a seperate  directory for  HS\Link
  214.           uploads just in case) - Please  note this is the directory  number
  215.           as defined in Telegard, ie, if the filebase is HSLINK UPLOADS  #2,
  216.           then place a 2 in the place of  that variable.  The PORT and  BAUD
  217.           parameters are used to define what port/speed HSLK-TGI should  use
  218.           after  the  transfer  to  check  over  everything.  The   <HS\Link
  219.           Commands> are  whatever  extra  parameters you  wish  to  pass  to
  220.           HS\Link, as HSLK-TGI won't touch these.
  221.  
  222.           NOTE:Do NOT  include either  a -U  or a  -P on  the command  line.
  223.           HSLK-TGI  appends  these  already,  using  your  TEMP\2  path  for
  224.           uploads, and the PORT specified above  as the port for HS\Link  as
  225.           well.  If you  include either of  these, hazourdous results  could
  226.           occur.
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.                                                  - Page 2 -
  254.  
  255.                              Telegard Hs\Link Interface v1.00 Beta Documentation
  256.                           Copyright 1991,1992 by Tim Strike.  All rights reserved.
  257.  
  258.  
  259.                                        ___________
  260.  
  261.                                        OTHER NOTES
  262.                                        ___________
  263.  
  264.           STATUS LINES
  265.  
  266.                 HSLK-TGI provides it's own  status line on  line # 2  before
  267.           HS\Link is loaded.  This line  is colour Light Cyan on Blue,  with
  268.           Ligh blue ends.  It will appear on the screen, like:
  269.  
  270.           ▌USER: RIIM (#1) │ UL: 0/0k  DL: 1/50k │ TL: 40                 ▐
  271.  
  272.                  The TL will be the  time the user had  at the start of  the
  273.           transfer.   Since Telegard  seems to  write this  erratically,  it
  274.           won't always be up-to-date with the actual time left.
  275.  
  276.  
  277.           AFTER TRANSFER PROCESSING
  278.  
  279.                 HSLK-TGI will search the  TEMP\2 directory for any  received
  280.           files, and if it finds any,  will prompt the user to input  upload
  281.           descriptions, and then add them to the file bases.
  282.  
  283.                 HSLK-TGI does NOT do  any of the  following:  Add  GifSpecs,
  284.           Convert or Test Archives, or Auto-Validate the files.  It's highly
  285.           suggested that  you  force  all HS\Link  uploads  into  their  own
  286.           directory for these reasons.   (If I get  enough requests, I  will
  287.           add the code in, but otherwise my time can be spent elsewhere...).
  288.  
  289.                 HSLK-TGI will also attempt to move the file into the correct
  290.           directory.  It  does NOT check  for duplicates on  any files,  but
  291.           again this may be fixed come release version.
  292.  
  293.                 HSLK-TGI also  does no  time-recovery this  version, so  the
  294.           user  won't  be  rewarded  any  time  for  uploading  (since  they
  295.           downloaded as well).
  296.  
  297.                 When DSZLOG  is  created, it  contains  the upload  AND  the
  298.           download information.   HSLK-TGI  removes the  upload  information
  299.           from  this  file,  otherwise  Telegard  assumes  an   unauthorized
  300.           download, which isn't close to the truth.
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.                                                  - Page 3 -
  318.  
  319.                              Telegard Hs\Link Interface v1.00 Beta Documentation
  320.                           Copyright 1991,1992 by Tim Strike.  All rights reserved.
  321.  
  322.  
  323.                                   ____________________
  324.  
  325.                                   EXAMPLE INSTALLATION
  326.                                   ____________________
  327.  
  328.                This following section is  an example configuration, as  used
  329.           by me when testing out HSLK-TGI.   It is in it's simplest form  so
  330.           you may wish to expand on these examples in your own installation.
  331.  
  332.                Since Telegard will  gather the  files it  needs to  download
  333.           from the user input (as a Batch Download) it needs to be setup  as
  334.           a Batch Download protocol:
  335.  
  336.                (You can also set  it up as a  normal protocol, in that  case
  337.           just make sure you include  whatever command parameters you  would
  338.           normally use to  stop uploads from  coming through, ie  single-way
  339.           mode).
  340.  
  341.            Protocol #19 of 19
  342.            !. Type/protocl:Active - Batch protocol
  343.            1. Keys/descrip:"H" / "(H)S\Link Experimental"
  344.            2. ACS required: ""
  345.            3. Temp. log   : "%C\dsztemp.log"
  346.            4. <U>L log    : "%C\xfer.log"
  347.               <D>L log    : "%C\xfer.log"
  348.            5. <U>L command: *None*
  349.               <D>L command: "HSLK-TGI D:\BBS\ 1 %P %B @%L"
  350.            6. Codes mean  :Transfer bad
  351.            7. <U>L codes  :(1)""   (2)""   (3)""   (4)""   (5)""   (6)""
  352.               <D>L codes  :(1)"E"  (2)"e"  (3)"L"  (4)"l"  (5)""   (6)""
  353.            E. Environ. cmd: "set DSZLOG=%T"
  354.            I. DL File list: "%C\fi.lst"
  355.            C. Max DOS chrs:128   P. Log position: Filename: 51 - Status: 1
  356.  
  357.                It basically matches  your Zmodem protocol,  except that  the
  358.           upload commandline  has been  toggled  'Inactive' (fiddle  till  a
  359.           little  *None*  comes  up)  and  the  download  command  line   is
  360.           different.
  361.  
  362.                If you have  your Protocol  path defined  as something  other
  363.           then a  null,  you  _must_ put  HSLK-TGI.EXE  in  that  directory,
  364.           otherwise it will not work.
  365.  
  366.                I would suggest  telling your  users 'how'  to transfer  with
  367.           HS\Link on a Telegard board.   I'll basically quickly run it  down
  368.           for you in it's simplified way.
  369.  
  370.            1. Select files you want to download as normal, except make them
  371.               a batch Download.
  372.            2. Goto the Batch Menu, and choose to transfer the files
  373.               (Download them), choose HS\Link and begin the transfer.
  374.            3. Start sending the files you wish to send while you're
  375.               downloading the files.
  376.            4. Enter descriptions afterwards.
  377.  
  378.  
  379.  
  380.  
  381.                                                  - Page 4 -
  382.  
  383.                              Telegard Hs\Link Interface v1.00 Beta Documentation
  384.                           Copyright 1991,1992 by Tim Strike.  All rights reserved.
  385.  
  386.  
  387.                                         ________
  388.  
  389.                                         VERSIONS
  390.                                         ________
  391.  
  392.                This will contain UPDATE info for future releases, as well as
  393.           some bugs fixes  and a  general summary  of all  the new  features
  394.           added. Please  read this  section of  the documentation  on  every
  395.           update if you don't plan on reading any of the other inform
  396.  
  397.            +:New Feature   *:Updated (Fixed) Feature   $:Wide Beta Feature
  398.  
  399.                                      v1.00 Wide Beta
  400.  
  401.           $ First Test Release.  Since HS\Link  hasn't  made it out of the
  402.             Beta stages yet, I've decided neither will HSLK-TGI.  I can
  403.             almost guarentee this won't work on many systems, so please take
  404.             care when installing this Wide Beta version.  I will not be
  405.             responsible for your choice to install this test version of
  406.             HSLK-TGI.
  407.  
  408.             Note: At this time, HS\Link has made an official release as
  409.             v1.00, and can be obtained on many boards around the country.
  410.  
  411.             PLEASE NOTE THAT YOU RUN THIS WIDE BETA VERSION OF HSLK-TGI AT
  412.             YOUR OWN RISK.  IT IS NOT FULLY FUNCTIONAL, SO PLEASE UNDERSTAND
  413.             THAT ANY PROBLEMS ARISING FROM THE USE OR MISUSE OF THIS PROGRAM
  414.             ARE SOLELY YOUR PROBLEM.
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433.  
  434.  
  435.  
  436.  
  437.  
  438.  
  439.  
  440.  
  441.  
  442.  
  443.  
  444.  
  445.                                                  - Page 5 -
  446.  
  447.                              Telegard Hs\Link Interface v1.00 Beta Documentation
  448.                           Copyright 1991,1992 by Tim Strike.  All rights reserved.
  449.  
  450.  
  451.                                    __________
  452.  
  453.                                    LEGALITIES
  454.                                    __________
  455.  
  456.           WARRANTY
  457.  
  458.                HSLK-TGI is provided as-is, without  a warranty of any  kind,
  459.           either expressed or implied.  It is only guaranteed to occupy disk
  460.           space, nothing more.  Under  no circumstances shall the author  be
  461.           liable to you or anyone else  for any damages, including (but  not
  462.           limited to) any lost profits, lost savings or other incidental  or
  463.           consequential damages arising  out of  the use or  misuse of  this
  464.           program.
  465.  
  466.                In other  words; RUN  THIS PROGRAM  AT YOUR  OWN RISK.    You
  467.           yourself, and  nobody  else  is responsible  for  the  outcome  of
  468.           choosing to run this program.
  469.  
  470.                But NEVER the less, all care should be taken whenever you run
  471.           new programs on  your system.   Files opened  by HSLK-TGI  include
  472.           LASTON.DAT and UPLOADS.DAT, files  opened and changed include  any
  473.           .DIR directory listings, STATUS.DAT and USER.LST.
  474.  
  475.                 Make backups of these files, and continue to make backups of
  476.           all your files used  with BBSs.   Trust me; I've  had way to  many
  477.           crashes, and it's always good to have a backup.
  478.  
  479.           Again, run this program at your own risk.
  480.  
  481.           COPYRIGHT
  482.  
  483.                The program,  and all  documents and  files included  in  the
  484.           HSLK-TGI  release  package  are  copyrighted  to  Tim  Strike  and
  485.           Forbidden Knights  [BBS] Software  Systems.   They are  not to  be
  486.           modified in  any  way, shape  or  form; However  the  distribution
  487.           archive may be changed from ARJ so long as no files are added  nor
  488.           removed.
  489.  
  490.                HSLK-TGI can not be  included on any distribution  diskettee,
  491.           nor can it  be included  in any distribution  archive without  the
  492.           proir written consent of Tim Strike.
  493.  
  494.           CREDITS
  495.  
  496.                All brand and product names  referenced in this document  are
  497.           trademarks, registered trademarks, or  copyrighted works of  their
  498.           respective holders.
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.                                                  - Page 6 -
  510.  
  511.                              Telegard Hs\Link Interface v1.00 Beta Documentation
  512.                           Copyright 1991,1992 by Tim Strike.  All rights reserved.
  513.  
  514.  
  515.                                   _____________
  516.  
  517.                                   REGISTRATION?
  518.                                   _____________
  519.  
  520.           [ Will be  completed upon  the release of the standard version  of
  521.           HSLK-TGI, though for now it will remain empty, and in the  future,
  522.           will likely remain free. ]
  523.  
  524.  
  525.                               _____________________
  526.  
  527.                               CONTACTING THE AUTHOR
  528.                               _____________________
  529.  
  530.                I may be reached  by sending netmail  to TeleNet Canada  Node
  531.           20:22/0, FidoNet Node 1:259/423 or  USTGNET Node 85:896/101.   You
  532.           may also choose to post a message to me through either the TeleNet
  533.           Canada Telegard Conference, or  the Telegard Utilities  Conference
  534.           of USTGNET.
  535.  
  536.                I may also be reached via my own board, Forbidden Knights  at
  537.           [416]820-7273.  2400-14,400 HST.  Before 4:00am, after 6:00am.
  538.  
  539.                Any changes or updates that need to be made to HSLK-TGI v1.00
  540.           will be made a new version will be released.  Further suggestions,
  541.           comments and/or bug  reports can  be directed through  one of  the
  542.           above methods.
  543.  
  544.                 Anyways, I hope you will enjoy the use of HSLK-TGI.  It  has
  545.           taken a  while  to  produce  and test,  and  hopefully  you'll  be
  546.           plesantly surprised with this program.
  547.  
  548.           Enjoy fully.
  549.  
  550.           Sincerly,
  551.           Tim Strike, Forbidden Knights [BBS] Software Systems & Programming.
  552.  
  553.  
  554.  
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.                                                  - Page 7 -
  574.  
  575.                              Telegard Hs\Link Interface v1.00 Beta Documentation
  576.                           Copyright 1991,1992 by Tim Strike.  All rights reserved.
  577.